Game Programming in C++ - Start to Finish

home *** CD-ROM | disk | FTP | other *** search

/ Game Programming in C++ - Start to Finish / GameProgrammingS.iso / Peon / PeonSDK-Win32-1.0.0.exe / {app} / PeonMain / include / CEGUI / elements / CEGUITooltip.h < prev next >

Wrap

C/C++ Source or Header | 2005-09-07 | 11.9 KB | 347 lines

/************************************************************************ filename: CEGUITooltip.h created: 21/2/2005 author: Paul D Turner *************************************************************************/ /************************************************************************* Crazy Eddie's GUI System (http://www.cegui.org.uk) Copyright (C)2004 - 2005 Paul D Turner (paul@cegui.org.uk) This library is free software; you can redistribute it and/or modify it under the terms of the GNU Lesser General Public License as published by the Free Software Foundation; either version 2.1 of the License, or (at your option) any later version. This library is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License for more details. You should have received a copy of the GNU Lesser General Public License along with this library; if not, write to the Free Software Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA *************************************************************************/ #ifndef _CEGUITooltip_h_ #define _CEGUITooltip_h_ #include "CEGUIWindow.h" #include "elements/CEGUITooltipProperties.h" #if defined(_MSC_VER) # pragma warning(push) # pragma warning(disable : 4251) #endif // Start of CEGUI namespace section namespace CEGUI { class CEGUIEXPORT Tooltip : public Window { public: /************************************************************************* Constants *************************************************************************/ static const String EventNamespace; //!< Namespace for global events static const String EventHoverTimeChanged; //!< Event fired when the hover timeout gets changed. static const String EventDisplayTimeChanged; //!< Event fired when the display timeout gets changed. static const String EventFadeTimeChanged; //!< Event fired when the fade timeout gets changed. static const String EventTooltipActive; //!< Event fired when the tooltip is about to get activated. static const String EventTooltipInactive; //!< Event fired when the tooltip has been deactivated. /************************************************************************ Object Construction and Destruction ************************************************************************/ /*! \brief Constructor for the Tooltip base class constructor */ Tooltip(const String& type, const String& name); /*! \brief Destructor for the Tooltip base class. */ ~Tooltip(void); /************************************************************************ Public interface ************************************************************************/ /*! \brief Sets the target window for the tooltip. This used internally to manage tooltips, you should not have to call this yourself. \param wnd Window object that the tooltip should be associated with (for now). \return Nothing. */ void setTargetWindow(Window* wnd); /*! \brief return the current target window for this Tooltip. \return Pointer to the target window for this Tooltip or 0 for none. */ const Window* getTargetWindow(); /*! \brief Resets the timer on the tooltip when in the Active / Inactive states. This is used internally to control the tooltip, it is not normally necessary to call this method yourself. \return Nothing. */ void resetTimer(void); /*! \brief Return the number of seconds the mouse should hover stationary over the target window before the tooltip gets activated. \return float value representing a number of seconds. */ float getHoverTime(void) const; /*! \brief Set the number of seconds the tooltip should be displayed for before it automatically de-activates itself. 0 indicates that the tooltip should never timesout and auto-deactivate. \param seconds float value representing a number of seconds. \return Nothing. */ void setDisplayTime(float seconds); /*! \brief Return the number of seconds that should be taken to fade the tooltip into and out of visibility. \return float value representing a number of seconds. */ float getFadeTime(void) const; /*! \brief Set the number of seconds the mouse should hover stationary over the target window before the tooltip gets activated. \param seconds float value representing a number of seconds. \return Nothing. */ void setHoverTime(float seconds); /*! \brief Return the number of seconds the tooltip should be displayed for before it automatically de-activates itself. 0 indicates that the tooltip never timesout and auto-deactivates. \return float value representing a number of seconds. */ float getDisplayTime(void) const; /*! \brief Set the number of seconds that should be taken to fade the tooltip into and out of visibility. \param seconds float value representing a number of seconds. \return Nothing. */ void setFadeTime(float seconds); // /*! \brief Causes the tooltip to position itself appropriately. \return Nothing. */ void positionSelf(void); protected: /************************************************************************* Implementation Methods *************************************************************************/ /*! \brief Add ScrollablePane specific events */ void addTooltipEvents(void); // methods to perform processing for each of the widget states void doActiveState(float elapsed); void doInactiveState(float elapsed); void doFadeInState(float elapsed); void doFadeOutState(float elapsed); // methods to switch widget states void switchToInactiveState(void); void switchToActiveState(void); void switchToFadeInState(void); void switchToFadeOutState(void); /*! \brief Return whether this window was inherited from the given class name at some point in the inheritance heirarchy. \param class_name The class name that is to be checked. \return true if this window was inherited from \a class_name. false if not. */ virtual bool testClassName_impl(const String& class_name) const { if (class_name==(const utf8*)"Tooltip") return true; return Window::testClassName_impl(class_name); } /*! \brief Return the size of the area that will be occupied by the tooltip text, given any current formatting options. \return Size object describing the size of the rendered tooltip text in pixels. */ virtual Size getTextSize() const; /************************************************************************* Event triggers *************************************************************************/ /*! \brief Event trigger method called when the hover timeout gets changed. \param e WindowEventArgs object. \return Nothing. */ virtual void onHoverTimeChanged(WindowEventArgs& e); /*! \brief Event trigger method called when the display timeout gets changed. \param e WindowEventArgs object. \return Nothing. */ virtual void onDisplayTimeChanged(WindowEventArgs& e); /*! \brief Event trigger method called when the fade timeout gets changed. \param e WindowEventArgs object. \return Nothing. */ virtual void onFadeTimeChanged(WindowEventArgs& e); /*! \brief Event trigger method called just before the tooltip becomes active. \param e WindowEventArgs object. \return Nothing. */ virtual void onTooltipActive(WindowEventArgs& e); /*! \brief Event trigger method called just after the tooltip is deactivated. \param e WindowEventArgs object. \return Nothing. */ virtual void onTooltipInactive(WindowEventArgs& e); /************************************************************************ Overridden from Window. ************************************************************************/ void updateSelf(float elapsed); void onMouseEnters(MouseEventArgs& e); void onTextChanged(WindowEventArgs& e); /************************************************************************ Enumerations ************************************************************************/ /*! \brief states for tooltip */ enum TipState { Inactive, //!< Tooltip is currently inactive. Active, //!< Tooltip is currently displayed and active. FadeIn, //!< Tooltip is currently transitioning from Inactive to Active state. FadeOut //!< Tooltip is currently transitioning from Active to Inactive state. }; /************************************************************************ Data fields ************************************************************************/ TipState d_state; //!< Current tooltip state. float d_elapsed; //!< Used to track state change timings const Window* d_target; //!< Current target Window for this Tooltip. float d_hoverTime; //!< tool-tip hover time (seconds mouse must stay stationary before tip shows). float d_displayTime; //!< tool-tip display time (seconds that tip is showsn for). float d_fadeTime; //!< tool-tip fade time (seconds it takes for tip to fade in and/or out). private: /************************************************************************* Static Properties for this class *************************************************************************/ static TooltipProperties::HoverTime d_hoverTimeProperty; static TooltipProperties::DisplayTime d_displayTimeProperty; static TooltipProperties::FadeTime d_fadeTimeProperty; /************************************************************************* Private methods *************************************************************************/ void addTooltipProperties(void); }; } // End of CEGUI namespace section #if defined(_MSC_VER) # pragma warning(pop) #endif #endif // end of guard _CEGUITooltip_h_